[llvm][docs] Improve the formatting of the Common Problems section #108522
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I realised this existed after answering https://discourse.llvm.org/t/clang-development-environment/81140. * Mark options, option values and program names as plain text. * Add a blank line between the option and the explanatory text so that it doesn't get printed on the same line. (this seems to be the original intent of the rst source anyway) * Update the phrasing of a couple of the options.
Collaborator
Author
|
With the added spacing it renders them like:
|
DavidSpickett
changed the title
Collaborator
Author
|
ping! |
1 similar comment
Collaborator
Author
|
ping! |
tru
reviewed
Oct 7, 2024
DavidSpickett
force-pushed
the
llvm-doc
branch
from
18e4604 to
cd52a69
Compare
tru
approved these changes
Oct 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
...and add shared libs as a suggestion.
so that it doesn't get printed on the same line.
(this seems to be the original intent of the rst source anyway)